Add docstring example to Figure.logo#4458
Closed
Silver19368 wants to merge 4 commits intoGenericMappingTools:mainfrom
Closed
Add docstring example to Figure.logo#4458Silver19368 wants to merge 4 commits intoGenericMappingTools:mainfrom
Silver19368 wants to merge 4 commits intoGenericMappingTools:mainfrom
Conversation
Member
|
@Silver19368 Thanks for adding this example. Since these doctest examples are not meant for testing purposes, we usually skip them when running tests. This is done by adding the following line at the start of the code. |
| >>> # Create a basemap to give the plot a coordinate system | ||
| >>> fig.basemap(region=[0, 10, 0, 10], projection="X10c", frame=True) | ||
| >>> # Add the GMT logo in the Top Right (TR) corner of the plot, | ||
| >>> # scaled to be 2 cm wide and offset by 0.5 cm in x and y. |
Member
There was a problem hiding this comment.
Suggested change
| >>> # scaled to be 2 cm wide and offset by 0.5 cm in x and y. | |
| >>> # scaled to be 2 cm wide and offset by 0.5 cm in x and y directions. |
| >>> import pygmt | ||
| >>> from pygmt.params import Position | ||
| >>> fig = pygmt.Figure() | ||
| >>> # Create a basemap to give the plot a coordinate system |
Member
There was a problem hiding this comment.
Hm. I am wondering whether we should focus on the specific function or method and only add comments for this.
Suggested change
| >>> # Create a basemap to give the plot a coordinate system |
Member
|
Ping @Silver19368 |
Member
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
Added a
doctestexample to theFigure.logodocstring to demonstrate its practical usage.Fixes #4456